Skip to content

[Docs] [6/N] Refactor Readme: Streamline README and move setup/trace details to other places#2652

Open
ykwd wants to merge 9 commits into
kvcache-ai:mainfrom
ykwd:docs/update-readme-6
Open

[Docs] [6/N] Refactor Readme: Streamline README and move setup/trace details to other places#2652
ykwd wants to merge 9 commits into
kvcache-ai:mainfrom
ykwd:docs/update-readme-6

Conversation

@ykwd

@ykwd ykwd commented Jun 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

This PR streamlines the root README.md and moves detailed setup and trace content into the documentation site and FAST25-release/, so the README stays a concise entry point while full guides remain easy to find.

Motivation

The root README had grown long, with setup details duplicated between the README and the docs. This change:

  1. Makes the README easier to scan for new visitors.
  2. Keeps detailed instructions in one place (the documentation site).
  3. Keeps trace-related content co-located under FAST25-release/.

PR Content

README improvements

  • Overview: Remove the redundant architecture diagram and long narrative; replace with a shorter, component-focused description (Transfer Engine, Mooncake Store, Mooncake EP & PG).
  • Getting Started (formerly Quick Start): Keep only essential pip install commands; link to the docs for prerequisites, source builds, deployment, and other accelerator backends.
  • AI Assistant Skills: Collapse the skills table and plugin install instructions into a <details> block to reduce visual clutter.
  • Open Source Traces: Move trace JSON samples into FAST25-release/README.md; summarize traces in the README and link to FAST25-release, plus the KV Cache Size Calculator and Hit Rate Simulator tools.
  • Citation: Surface the FAST'25 paper as the primary citation; move other papers into a collapsible "More" section.

Documentation sync

  • Move the "Before using Mooncake" prerequisites and expanded installation notes (CUDA 13, NPU, package variants, runtime dependencies) from the README into docs/source/getting_started/quick-start.md.

New file

  • Add FAST25-release/README.md with trace sample format and release notes (content previously inline in the root README).

Changes

File Change
README.md ~132 lines changed (net reduction)
docs/source/getting_started/quick-start.md +35 lines (prerequisites & install details)
FAST25-release/README.md +17 lines (new)

@github-actions github-actions Bot added documentation Improvements or additions to documentation run-ci labels Jun 28, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the documentation across several files, including the main README, the FAST'25 release notes, and the quick-start guide. The updates provide a clearer overview of Mooncake's architecture, simplify the installation instructions for different hardware backends, introduce new KV cache analysis tools, and update the citation section. The review comments suggest minor grammatical and formatting improvements, such as correcting the phrasing of an open-source link and fixing a spacing issue alongside a relative link path. Both comments are valid and should be addressed.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread README.md Outdated
Comment thread FAST25-release/README.md Outdated
ykwd and others added 3 commits June 28, 2026 14:14
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@ykwd ykwd force-pushed the docs/update-readme-6 branch from 37b3834 to 9d470ed Compare June 28, 2026 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation run-ci

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant